Generalizes golden script tests #469
Open
+238
−64
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
Generalizes golden bash tests to support arbitrary scripting environments by introducing a generic ScriptTest framework. Key changes:
- Renames
BashTest/BashConfigtoScriptTest/ScriptConfigand updates the consuming code. - Adds a
ScriptExtensionsmap to configure commands for different file extensions. - Updates existing tests to pass
ScriptConfigwhile keeping aBashTestwrapper for backward compatibility.
Reviewed Changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| run/tests/simple/main_test.go | Switched from BashConfig to ScriptConfig in simple test. |
| run/tests/http/too_many_requests/main_test.go | Same switch in HTTP too-many-requests test. |
| run/tests/http/sync/main_test.go | Same switch in HTTP sync test. |
| run/tests/http/error_log/main_test.go | Same switch in HTTP error-log test. |
| run/tests/http/async/main_test.go | Same switch in HTTP async test. |
| golden/script.go | Introduced generic ScriptTest logic; removed hardcoded .sh paths. |
| golden/dag.go | Updated DagTest to use ScriptConfig instead of BashConfig. |
| golden/config.go | Renamed BashConfig to ScriptConfig and added ScriptExtensions. |
Comments suppressed due to low confidence (5)
golden/script.go:38
- [nitpick] Update the doc comment to clarify that
ScriptTestconsiders all extensions provided inScriptExtensions, not just.shfiles.
// ScriptTest executes a golden file test for scripts. It walks over the
run/tests/simple/main_test.go:41
- [nitpick] The test function is still named
TestGoldenBashbut now runs generic scripts; consider renaming it toTestGoldenScriptto reflect the new behavior.
func TestGoldenBash(t *testing.T) {
golden/script.go:10
- Add missing imports for packages used in this file: fmt (for fmt.Sprintf and fmt.Errorf), bytes (for bytes.Buffer), and encoding/json (for JSON marshal/unmarshal in processOutput).
"slices"
golden/dag.go:74
- Initializing
ScriptConfigwithout defaultingScriptExtensionsmeansScriptTestwill fail; consider settingScriptExtensions = map[string]string{".sh":"bash"}whenConfigis nil or require it in the test cases.
config := ScriptConfig{}
golden/script.go:198
- [nitpick] Using the full script path as the subtest name may be too verbose; consider using
filepath.Base(script)for a concise test name.
t.Run(script, f)
…script-tests' into merschformann/generalize-golden-script-tests
…ralize-golden-script-tests
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Generalizes former golden bash tests to golden script tests, i.e., allows use of the tooling for other scripting environments like PowerShell, etc..
Changes
You can now specify how your scripts need to be run:
This allows you to run PowerShell, other scripts or even totally different tools with the same functionality. Just define a specific extension for them and a command to run them.
BashTestwas renamed toScriptTestto better reflect the new functionality.BashTestFilewas renamed toScriptTestFileand now accepts a command for running the script (instead of fixing it tobash).BashTestFileandBashTestare still available for backwards compatibility reasons though.Resolves ENG-6270